<!DOCTYPE html>

<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">

<title>licence_injector - Inject licence text into source files</title>

<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "./";
</script>

<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>


<body>
<nav id="metadata">
  <nav id="home-section" class="section">
  <h3 class="section-header">
    <a href="./index.html">Home</a>
    <a href="./table_of_contents.html#classes">Classes</a>
    <a href="./table_of_contents.html#methods">Methods</a>
  </h3>
</nav>


  <nav id="search-section" class="section project-section" class="initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <h3 class="section-header">
      <input type="text" name="search" placeholder="Search" id="search-field"
             title="Type to search, Up and Down to navigate, Enter to load">
    </h3>
  </form>

  <ul id="search-results" class="initially-hidden"></ul>
</nav>


  <div id="project-metadata">
    <nav id="fileindex-section" class="section project-section">
  <h3 class="section-header">Pages</h3>

  <ul>
  
    <li class="file"><a href="./README_rdoc.html">README</a>
  
  </ul>
</nav>

    <nav id="classindex-section" class="section project-section">
  <h3 class="section-header">Class and Module Index</h3>

  <ul class="link-list">
  
    <li><a href="./LicenceInjector.html">LicenceInjector</a>
  
    <li><a href="./Licence_Injector.html">Licence_Injector</a>
  
    <li><a href="./Object.html">Object</a>
  
    <li><a href="./OptionParser.html">OptionParser</a>
  
  </ul>
</nav>

  </div>
</nav>

<div id="documentation" class="description">

<h1 id="label-%27licence_injector%27+-+Injects+licence+text+into+source+file">&#39;licence_injector&#39; - Injects licence text into source file<span><a href="#label-%27licence_injector%27+-+Injects+licence+text+into+source+file">&para;</a> <a href="#documentation">&uarr;</a></span></h1>
<dl class="rdoc-list note-list"><dt>Author
<dd>
<p>Barry Drinkwater (<a
href="mailto:barry@penrillian.com">barry@penrillian.com</a>)</p>
</dd><dt>Copyright
<dd>
<p>Copyright © 2013 Penrillian</p>
</dd><dt>Licence
<dd>
<p>Distributed under the BSD Clause 2 licence, see LICENCE.txt</p>
</dd></dl>

<p>This application injects text from the given licence file into each source
file found in the given source path whose extension is one of those in the
given list of extensions. It handles xml files and files containing a
shebang; both of these type of files require that their first lines remain
unaltered. Also, a previously injected licence can be replaced with a new
licence.</p>

<h2 id="label-Install">Install<span><a href="#label-Install">&para;</a> <a href="#documentation">&uarr;</a></span></h2>

<p>Install:</p>

<pre>gem install licence_injector</pre>

<h2 id="label-Use">Use<span><a href="#label-Use">&para;</a> <a href="#documentation">&uarr;</a></span></h2>

<p>Inject licence:</p>

<p>licence_injector inject [options]</p>

<p>Replace licence:</p>

<p>licence_injector replace [options]</p>

<p>For more help:</p>

<pre>licence_injector --help</pre>

<p>and:</p>

<pre>gem man licence_injector</pre>

<h2 id="label-Developing+for+%27licence_injector%27">Developing for &#39;licence_injector&#39;<span><a href="#label-Developing+for+%27licence_injector%27">&para;</a> <a href="#documentation">&uarr;</a></span></h2>

<pre>gem install bundler</pre>

<p>Get the development dependencies</p>

<pre>bundle install</pre>

<p>Most of the code is in &#39;lib/LicenceInjector.rb&#39; and
&#39;bin/licence_injector&#39;</p>
</div>


<footer id="validator-badges">
  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>

